Skip to content

Docs update: Clarifies only executing runs count towards concurrency#1760

Merged
ericallam merged 1 commit intomainfrom
docs/clarify-concurrency
Mar 5, 2025
Merged

Docs update: Clarifies only executing runs count towards concurrency#1760
ericallam merged 1 commit intomainfrom
docs/clarify-concurrency

Conversation

@samejr
Copy link
Member

@samejr samejr commented Mar 5, 2025 •
edited by coderabbitai bot
Loading

Small text update to clarify only executing runs count towards concurrency

Summary by CodeRabbit

  • Documentation
    • Updated the explanation on concurrency limits in task execution to clarify that only active runs count towards the concurrency cap, while queued or delayed runs do not consume slots until they start executing.

@changeset-bot
Copy link

changeset-bot bot commented Mar 5, 2025

⚠️ No Changeset found

Latest commit: 28c7a8e

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 5, 2025 •
edited
Loading

Walkthrough

The pull request updates the task execution documentation to clarify how concurrency limits are applied. It explicitly states that only actively executing runs are counted towards the concurrency limits, while runs in a delayed or queued state do not consume concurrency slots until they start executing. No changes to exported or public entities were made.

Changes

File(s) Change Summary
docs/queue-concurrency.mdx Added an explanatory line clarifying that only active task executions count towards concurrency limits; queued runs are excluded until execution begins.

Possibly Related PRs

Poem

I’m a rabbit, quick on my feet,
Hopping through docs, where changes meet.
Concurrency is now clear and bright,
Active only takes the spotlight.
With queued tasks waiting out of sight,
My happy hops say “all is right!” 🐇

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 31c2a23 and 28c7a8e.

📒 Files selected for processing (1)
  • docs/queue-concurrency.mdx (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Analyze (javascript-typescript)
🔇 Additional comments (1)
docs/queue-concurrency.mdx (1)

10-11: Clear and Effective Clarification

The added explanatory sentence immediately underlines that only actively executing runs are counted towards concurrency, which directly addresses the PR objective. This clarification is succinct and improves readability, ensuring users understand that queued or delayed runs do not impact concurrency limits.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@ericallam ericallam merged commit 4358e2d into main Mar 5, 2025
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ericallam ericallam ericallam approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@samejr @ericallam